Skip to content

feat(site): update doc-core to 1.22.0#4946

Open
wise-king-sullyman wants to merge 16 commits intomainfrom
update-doc-core-1.15.4
Open

feat(site): update doc-core to 1.22.0#4946
wise-king-sullyman wants to merge 16 commits intomainfrom
update-doc-core-1.15.4

Conversation

@wise-king-sullyman
Copy link
Copy Markdown
Collaborator

Closes #4930

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Mar 3, 2026

Deploying patternfly-org with  Cloudflare Pages  Cloudflare Pages

Latest commit: f6ec840
Status: ✅  Deploy successful!
Preview URL: https://586e2e2f.patternfly-org.pages.dev
Branch Preview URL: https://update-doc-core-1-15-4.patternfly-org.pages.dev

View logs

Copy link
Copy Markdown
Collaborator

@nicolethoen nicolethoen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this change mean that composing pages with embedded react components should be constructed or located differently than before? that'll be important to communicate to Erin.

import React from 'react';
import { Link as ReachLink, navigate } from '@reach/router';
import { getAsyncComponent } from '../../routes';
const { getAsyncComponent } = require('../../routes');
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why you'd be mixing import and require() in the same file

Copy link
Copy Markdown
Collaborator Author

@wise-king-sullyman wise-king-sullyman Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because some of the files we're importing from are ESM and some are CJS

"ci:build": "yarn generate:content && yarn build",
"clean": "rm -rf src/generated",
"generate:content": "patternfly-doc-core convert-to-mdx ../documentation-site/patternfly-docs/content/",
"generate:content": "rm -rf src/content && cp -r ../documentation-site/patternfly-docs/content src/content",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does doc-core 1.20.0 handle .md files natively now without needing to convert to mdx?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't handle them natively per se, but it does now include the conversion internally in its build pipeline

"astro": "^5.16.10"
"@patternfly/patternfly-doc-core": "^1.20.0",
"@patternfly/react-icons": "^6.5.0-prerelease.14",
"astro": "^5.15.9"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this an intentional bump down for the astro version?

@patternfly-build
Copy link
Copy Markdown
Collaborator

patternfly-build commented Apr 6, 2026

Preview: https://pf-org--pr-4946-site.surge.sh

@wise-king-sullyman wise-king-sullyman changed the title feat(site): update doc-core to 1.20.0 feat(site): update doc-core to 1.22.0 Apr 7, 2026
Copy link
Copy Markdown
Collaborator

@nicolethoen nicolethoen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

two call outs

"ci:build": "yarn generate:content && yarn build",
"clean": "rm -rf src/generated",
"generate:content": "patternfly-doc-core convert-to-mdx ../documentation-site/patternfly-docs/content/",
"generate:content": "rm -rf src/content && mkdir -p src/content && cp -r ../documentation-site/patternfly-docs/content src/content",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's a nesting bug here

cp -r ../documentation-site/patternfly-docs/content src/content will copy the content directory into src/content/, giving you src/content/content/... instead of src/content/....

You'd want either:

  • rm -rf src/content && cp -r ../documentation-site/patternfly-docs/content src/content (skip the mkdir -p and let cp create the target)
  • rm -rf src/content && mkdir -p src/content && cp -r ../documentation-site/patternfly-docs/content/* src/content/ to copy the contents instead of the directory itself.

---
id: About us
title: About us
section: Get started
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this should move to the Get started section. This is something that I believe Erin moved above the getting started section on staging on purpose

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Pull latest doc-core version into the site package and add all docs to it

3 participants